feat: accept prop for heading level (#1751) #1865
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rswerve
requested review from
ahobson,
brandonlenz,
gidjin,
haworku,
sarboc,
SirenaBorracha and
suzubara
as code owners
haworku
reviewed
Jan 7, 2022
src/components/stepindicator/StepIndicator/StepIndicator.stories.tsx
Outdated
Show resolved
Hide resolved
suzubara
previously approved these changes
Jan 7, 2022
…es.tsx rename Storybook story Co-authored-by: haworku <haworku@users.noreply.github.com>
haworku
approved these changes
Jan 7, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The heading level in the StepIndicator currently defaults to
h4, and the inability to change this causes an accessibility issue when used in a document that doesn't includeh1,h2, andh3. We should be able to specify the desired heading level.This PR introduces a
headingLevelprop to the StepIndicator, so that any given instance can have any valid heading level.In order to make this a non-breaking change, if no heading level is specified, the component maintains the current behavior of defaulting to
h4.Related Issues or PRs
Closes #1751
How To Test
In Storybook, select the Heading variant of the StepIndicator, and inspect the markup to see that it accords with the screenshot below.
Review new unit tests.
Screenshots (optional)